From: Florian Müllner Date: Tue, 16 Jan 2024 19:41:12 +0000 (+0100) Subject: docs: List additional docs and API references in README X-Git-Tag: archive/raspbian/50.5-1+rpi1~1^2~281^2~2^2~86 X-Git-Url: https://dgit.raspbian.org/%22http://www.example.com/cgi/%22/%22http:/www.example.com/cgi/%22?a=commitdiff_plain;h=8887301955accc4b78f1debe390d161d88432e0a;p=gnome-shell.git docs: List additional docs and API references in README With this change, all our documentation can now (directly or indirectly) be accessed from the toplevel README. Part-of: --- diff --git a/README.md b/README.md index dba27ce09..27fd39a02 100644 --- a/README.md +++ b/README.md @@ -96,6 +96,34 @@ The following guidelines will help your change to be successfully merged: [mr-handbook]: https://handbook.gnome.org/development/change-submission.html [commit-messages]: docs/commit-messages.md +## Documentation + + * [Coding style and conventions for javascript][js-style] + * [Coding style and conventions for C code][c-style] + * [The GJS Developer Guide][gjs-guide] + * [Building and Running][building] + * [Debugging][debugging] + +[js-style]: docs/js-coding-style.md +[c-style]: docs/c-coding-style.md +[gjs-guide]: https://gjs.guide +[building]: docs/building-and-running.md +[debugging]: docs/debugging.md + +## API Reference + + * [Meta][meta-docs]: Display server and window manager + * [St][st-docs]: Shell toolkit + * [Clutter][clutter-docs]: OpenGL based scene graph + * [Shell][shell-docs]: Non-ui shell objects and utilities + * See the [mutter page][mutter-docs] for additional documentation + +[st-docs]: +[shell-docs]: +[clutter-docs]: +[meta-docs]: +[mutter-docs]: + ## License GNOME Shell is distributed under the terms of the GNU General Public License,